vcCommandPanel

Provides services to display Python commands in the command panel.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Buttons	vcList[vcCommandPanelButton]	R	Gets all buttons to display in this command panel.
Title	String	RW	Gets or sets a panel title.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createButton	vcCommandPanelButton	None	"Creates a new button to display in this command panel." Returns: vcCommandPanelButton: The newly created button.
createButton	vcCommandPanelButton	String text, Callable clickHandler	"Creates a new button with a text and click handler to display in this command panel." See more Parameters: text (String): Text to display in the button. clickHandler (function): Function to execute when the button is pressed. Returns: vcCommandPanelButton: The newly created button.
new	vcCommandPanel	None	"Constructs a new command panel instance. Instance must be kept alive by the script." Returns: vcCommandPanel: The newly created panel.
setOnCancel	None	Callable OR None cancelHandler	Sets a function that's called when the command is cancelled (i.e. 'X' on the panel is pressed or another command is started). See more Parameters: cancelHandler (callable): The function to call when the command is cancelled.
showCommand	None	vcCommand command	"Shows the panel for the given command." Parameters: command (vcCommand): Command whose properties to show in the panel.